org.eclipse.vtp.framework.core
Interface ILogger

All Superinterfaces:

IReporter

All Known Subinterfaces:

IActionContext, IContext, IExecutionContext, IProcessContext, ISessionContext

All Known Implementing Classes:

AbstractActionContext, AbstractContext, AbstractExecutionContext, AbstractLogger, AbstractProcessContext, AbstractSessionContext, ActionContextWrapper, Execution.Context, ExecutionContextWrapper, Process.Context, ProcessContextWrapper, Sequence.Context, Session.Context, SessionContextWrapper

public interface ILogger
extends IReporter

An interface to use for common logging purposes.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.core.IReporter

SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, SEVERITY_WARN

Method Summary

void	debug(java.lang.String message) Creates and publishes a debug log entry with the specified attributes.
void	debug(java.lang.String[] categories, java.lang.String message) Creates and publishes a debug log entry with the specified attributes.
void	debug(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties) Creates and publishes a debug log entry with the specified attributes.
void	debug(java.lang.String message, java.util.Dictionary properties) Creates and publishes a debug log entry with the specified attributes.
void	error(java.lang.String message) Creates and publishes an error log entry with the specified attributes.
void	error(java.lang.String[] categories, java.lang.String message) Creates and publishes an error log entry with the specified attributes.
void	error(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties) Creates and publishes an error log entry with the specified attributes.
void	error(java.lang.String message, java.util.Dictionary properties) Creates and publishes an error log entry with the specified attributes.
void	info(java.lang.String message) Creates and publishes an informational log entry with the specified attributes.
void	info(java.lang.String[] categories, java.lang.String message) Creates and publishes an informational log entry with the specified attributes.
void	info(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties) Creates and publishes an informational log entry with the specified attributes.
void	info(java.lang.String message, java.util.Dictionary properties) Creates and publishes an informational log entry with the specified attributes.
boolean	isDebugEnabled() Returns true if the debug severity level is enabled.
boolean	isErrorEnabled() Returns true if the error severity level is enabled.
boolean	isInfoEnabled() Returns true if the informational severity level is enabled.
boolean	isWarnEnabled() Returns true if the warning severity level is enabled.
void	log(int severity, java.lang.String message) Creates and publishes a log entry with the specified attributes.
void	log(int severity, java.lang.String[] categories, java.lang.String message) Creates and publishes a log entry with the specified attributes.
void	log(int severity, java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties) Creates and publishes a log entry with the specified attributes.
void	log(int severity, java.lang.String message, java.util.Dictionary properties) Creates and publishes a log entry with the specified attributes.
void	warn(java.lang.String message) Creates and publishes a warning log entry with the specified attributes.
void	warn(java.lang.String[] categories, java.lang.String message) Creates and publishes a warning log entry with the specified attributes.
void	warn(java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties) Creates and publishes a warning log entry with the specified attributes.
void	warn(java.lang.String message, java.util.Dictionary properties) Creates and publishes a warning log entry with the specified attributes.

Methods inherited from interface org.eclipse.vtp.framework.core.IReporter

isSeverityEnabled, report, report, report, report

Method Detail

log

void log(int severity,
         java.lang.String message)

Creates and publishes a log entry with the specified attributes.

Parameters:

severity - The severity of the log entry.

message - The message associated with the log entry or null to not include a message.

log

void log(int severity,
         java.lang.String message,
         java.util.Dictionary properties)

Creates and publishes a log entry with the specified attributes.

Parameters:

severity - The severity of the log entry.

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

log

void log(int severity,
         java.lang.String[] categories,
         java.lang.String message)

Creates and publishes a log entry with the specified attributes.

Parameters:

severity - The severity of the log entry.

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

log

void log(int severity,
         java.lang.String[] categories,
         java.lang.String message,
         java.util.Dictionary properties)

Creates and publishes a log entry with the specified attributes.

Parameters:

severity - The severity of the log entry.

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

isErrorEnabled

boolean isErrorEnabled()

Returns true if the error severity level is enabled.

Returns:

True if the error severity level is enabled.

error

void error(java.lang.String message)

Creates and publishes an error log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

error

void error(java.lang.String message,
           java.util.Dictionary properties)

Creates and publishes an error log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

error

void error(java.lang.String[] categories,
           java.lang.String message)

Creates and publishes an error log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

error

void error(java.lang.String[] categories,
           java.lang.String message,
           java.util.Dictionary properties)

Creates and publishes an error log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

isWarnEnabled

boolean isWarnEnabled()

Returns true if the warning severity level is enabled.

Returns:

True if the warning severity level is enabled.

warn

void warn(java.lang.String message)

Creates and publishes a warning log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

warn

void warn(java.lang.String message,
          java.util.Dictionary properties)

Creates and publishes a warning log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

warn

void warn(java.lang.String[] categories,
          java.lang.String message)

Creates and publishes a warning log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

warn

void warn(java.lang.String[] categories,
          java.lang.String message,
          java.util.Dictionary properties)

Creates and publishes a warning log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

isInfoEnabled

boolean isInfoEnabled()

Returns true if the informational severity level is enabled.

Returns:

True if the informational severity level is enabled.

info

void info(java.lang.String message)

Creates and publishes an informational log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

info

void info(java.lang.String message,
          java.util.Dictionary properties)

Creates and publishes an informational log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

info

void info(java.lang.String[] categories,
          java.lang.String message)

Creates and publishes an informational log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

info

void info(java.lang.String[] categories,
          java.lang.String message,
          java.util.Dictionary properties)

Creates and publishes an informational log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

isDebugEnabled

boolean isDebugEnabled()

Returns true if the debug severity level is enabled.

Returns:

True if the debug severity level is enabled.

debug

void debug(java.lang.String message)

Creates and publishes a debug log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

debug

void debug(java.lang.String message,
           java.util.Dictionary properties)

Creates and publishes a debug log entry with the specified attributes.

Parameters:

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.

debug

void debug(java.lang.String[] categories,
           java.lang.String message)

Creates and publishes a debug log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

debug

void debug(java.lang.String[] categories,
           java.lang.String message,
           java.util.Dictionary properties)

Creates and publishes a debug log entry with the specified attributes.

Parameters:

categories - The categories the log entry pertains to or null if no catagories are related.

message - The message associated with the log entry or null to not include a message.

properties - The properties of the log entry or null if no properties are specified.